Assurance API
API Resources
The Assurance API allows you to:
- Retrieve product instance details
- Diagnose a fault
- Log a fault
- Manage faults
- View and schedule appointments
- View network events
- Subscribe to receive notifications and status updates
The Assurance API includes the following resources:
| Method and endpoint | Function |
|---|---|
GET /version | Retrieve the full version number of the API asset (major, minor and patch version numbers). |
GET /authorization | Get Authorization Application information. |
POST /sessions | Create a new diagnostic session. |
GET /sessions | Retrieve a set of diagnostic sessions. |
GET /sessions/{sessionid} | Retrieve a diagnostic session. |
GET /sessions/{sessionid}/schedule | Retrieve schedule details based on search criteria. |
POST /sessions/{sessionid}/reservations | Submit a Schedule Reservation Request for the Diagnostic Session. |
POST /sessions/{sessionid}/faultType | Update the fault type for the diagnostic session. |
POST /sessions/{sessionid}/problemReport | Submit a problem report for the diagnostic session. |
PUT /sessions/{sessionid}/cancel | Cancel a diagnostic session. |
POST /sessions/{sessionid}/diagnostics | Create a diagnostic test run. |
GET /sessions/{sessionid}/diagnostics/{diagnosticidentifier} | Retrieve a diagnostic test run. |
GET /products/{productid} | Get product information. |
POST /products/{productid}/factoryReset | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
POST /products/{productid}/reboot | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/wifi | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/wifi/{wifiPortIndex} | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
POST /products/{productid}/wifi/{wifiPortIndex}/reset | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/wan | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/wan | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/voice | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/voice/{voiceProfileIndex} | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/voice/{voiceProfileIndex}/voicePort/{voicePortIndex} | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/lan/ethernetPorts | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/lan/ethernetPorts/{ethernetPortIndex} | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/lan/staticIps | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/lan/staticIps | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/lan/dhcpIp | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
PUT /products/{productid}/lan/dhcpIp | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /products/{productid}/lan/hosts | The requested resource is no longer available. From 31 October 2024, RGW ONT mode is no longer supported by Chorus. |
GET /problemReport | Retrieve a set of problem reports. |
GET /problemReport/{problemnumber} | Retrieve a problem report. |
PUT /problemReport/{problemnumber} | Amend a problem report. |
POST /problemReport/{problemnumber}/close | Close a problem report. |
POST /problemReport/{problemnumber}/cancel | Cancel a problem report. |
POST /problemReport/{problemnumber}/update | Update a problem report. |
POST /problemReport/{problemnumber}/unlink | Unlink a problem report from an event. |
GET /events/{event_id} | Retrieve an event. |
GET /events/{event_id}/impact | Retrieve event impacts. |
GET /events/{event_id}/impactDownload | Download Event Impacts. |
GET /tests | Get tests. |
GET /tests/{testId} | Get a specific test. |
GET /tests/{testId}/images/{imageid} | Get test images. |
GET /subscriptions | Get subscription details. |
POST /subscriptons | Create a new subscription. Note: This requires a manual configuration change in Chorus's systems. See How to use the API for more details. |
GET /subscriptons/{subscriptionid} | Reference a subscription. |
PUT /subscriptons/{subscriptionid} | Update a subscription. |
POST /subscriptions/{subscriptionid}/delete | Delete a subscription. |
POST /subscriptions/{subscriptionid}/deactivate | Deactivate a subscription. |
GET /channels/{channelId}/notifications | Get notifications by channel. |
GET /channels/{channelId}/notifications/{notificationsid} | Used to reference notification to retrieve information. |